Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Auditlogs Filters now can be clicked on #2639

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

BadriVishalPadhy
Copy link
Contributor

@BadriVishalPadhy BadriVishalPadhy commented Nov 3, 2024

What does this PR do?

This PR fixes - on clicking any of the filter option in the audit log page except the system one, all events users and root keys are not clickable, only way to select them is via the keyboard

Fixes #2391

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • [x ] Bug fix (non-breaking change which fixes an issue)
  • [x ] Chore (refactoring code, technical debt, workflow improvements)
  • [x ] Enhancement (small improvements)
  • [x ] New feature (non-breaking change which adds functionality)
  • [x ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x ] This change requires a documentation update

How should this be tested?

Go to sidebar -> audit logs-> in the events tab drop down try clicking on options

Checklist

Required

  • [ x] Filled out the "How to test" section in this PR
  • [x ] Read Contributing Guide
  • [ x] Self-reviewed my own code
  • [x ] Commented on my code in hard-to-understand areas
  • [ x] Ran pnpm build
  • [ x] Ran pnpm fmt
  • [ x] Checked for warnings, there are none
  • [ x] Removed all console.logs
  • [ x] Merged the latest changes from main onto my branch with git pull origin main
  • [ x] My changes don't cause any responsiveness issues

Appreciated

issue-https://preview.screen.studio/share/zCAzNHHP
after resolvoing -
https://github.com/user-attachments/assets/67995c85-0929-41c0-b69c-86c19b41618c

  • [ x] If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Enhanced user interaction by allowing immediate selection or deselection of options through mouse button press.
  • Bug Fixes

    • Removed outdated hover behavior, streamlining the selection process.
  • Refactor

    • Consolidated selection logic into new event handlers for improved performance and clarity.

Copy link

changeset-bot bot commented Nov 3, 2024

⚠️ No Changeset found

Latest commit: e9fc596

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 10:10am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 10:10am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 10:10am
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 10:10am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 10:10am

Copy link

vercel bot commented Nov 3, 2024

@BadriVishalPadhy is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 3, 2024

📝 Walkthrough

Walkthrough

The changes in the pull request focus on the Filter component within the audit logs section of the dashboard. A new onMouseDownCapture event handler has been added to enhance the selection process for filter options. The previous hover-based selection mechanism has been removed, consolidating state updates into click interactions. The modifications ensure that users can select or deselect filter options immediately upon mouse button press, improving the overall user interaction model.

Changes

File Path Change Summary
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx Added onMouseDownCapture event handler to CommandItem, removed onMouseEnter, consolidated state updates.

Assessment against linked issues

Objective Addressed Explanation
Filter options should be clickable (#2391)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Nov 3, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@BadriVishalPadhy BadriVishalPadhy changed the title fix/Auditlogs-Filters-now-can-be-clicked-on fix: Auditlogs Filters now can be clicked on Nov 3, 2024
@BadriVishalPadhy
Copy link
Contributor Author

@chronark plz do check

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (1)

75-103: Consider refactoring duplicate state update logic.

The state update logic is duplicated between onMouseDownCapture and onSelect handlers. Consider extracting this into a shared function to improve maintainability.

Here's a suggested refactor:

+ const toggleSelection = () => {
+   const next = isSelected
+     ? selected.filter((v) => v !== option.value)
+     : Array.from(new Set([...selected, option.value]));
+   setSelected(next);
+ };

  <div 
    key={option.value}
-   onMouseDownCapture={() => {
-     const next = isSelected
-       ? selected.filter((v) => v !== option.value)
-       : Array.from(new Set([...selected, option.value]));
-     setSelected(next);
-   }}
+   onMouseDownCapture={toggleSelection}
  >
    <CommandItem
      key={option.value}
-     onSelect={() => {
-       const next = isSelected
-         ? selected.filter((v) => v !== option.value)
-         : Array.from(new Set([...selected, option.value]));
-       setSelected(next);
-     }}
+     onSelect={toggleSelection}
    >
🧰 Tools
🪛 Biome

[error] 75-83: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 56274c0 and 834a53f.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (1 hunks)
🧰 Additional context used
🪛 Biome
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx

[error] 75-83: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

🔇 Additional comments (2)
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (2)

93-98: LGTM! Well-structured styling implementation.

The conditional styling provides clear visual feedback and follows best practices:

  • Uses utility function for class merging
  • Proper state-based styling
  • Accessible implementation with proper icon visibility

75-103: Implementation successfully addresses the clicking issue.

The changes effectively solve the reported bug by:

  1. Adding mouse interaction through onMouseDownCapture
  2. Preserving existing keyboard navigation
  3. Maintaining proper visual feedback for selected state

This implementation aligns well with the PR objectives from issue #2391.

🧰 Tools
🪛 Biome

[error] 75-83: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

apps/dashboard/app/(app)/audit/[bucket]/filter.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (1)

75-104: Consider refactoring duplicate state update logic.

The state update logic is duplicated between onMouseDownCapture and onSelect handlers. Consider extracting this into a shared function to improve maintainability.

+ const toggleOption = (option: { value: string }) => {
+   const next = selected.includes(option.value)
+     ? selected.filter((v) => v !== option.value)
+     : Array.from(new Set([...selected, option.value]));
+   setSelected(next);
+ };

  <div
    key={option.value}
-   onMouseDownCapture={() => {
-     const next = isSelected
-       ? selected.filter((v) => v !== option.value)
-       : Array.from(new Set([...selected, option.value]));
-     setSelected(next);
-   }}
+   onMouseDownCapture={() => toggleOption(option)}
  >
    <CommandItem
      key={option.value}
-     onSelect={() => {
-       const next = isSelected
-         ? selected.filter((v) => v !== option.value)
-         : Array.from(new Set([...selected, option.value]));
-       setSelected(next);
-     }}
+     onSelect={() => toggleOption(option)}
    >
🧰 Tools
🪛 Biome

[error] 75-82: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 834a53f and e9fc596.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (1 hunks)
🧰 Additional context used
🪛 Biome
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx

[error] 75-82: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

🔇 Additional comments (2)
apps/dashboard/app/(app)/audit/[bucket]/filter.tsx (2)

92-103: LGTM! Clear visual feedback for selection state.

The implementation provides excellent visual feedback with the checkbox-like behavior and proper state management. This successfully addresses the original issue of filters not being clickable.


75-104: Verify the fix resolves the original issue.

The implementation looks good and directly addresses the reported issue in #2391. Please verify:

  1. All filter options are now clickable with mouse
  2. Keyboard navigation still works as before
  3. Visual feedback is clear when selecting/deselecting options
✅ Verification successful

Mouse interaction implementation is correctly isolated and non-conflicting

The implementation looks clean with only one mouse event handler (onMouseDownCapture) in the filters component, ensuring no conflicting mouse interactions. The dual-handling with both onMouseDownCapture and onSelect provides robust interaction support for both mouse and keyboard users.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify no other mouse event handlers that might interfere
rg -A 2 "onMouse" apps/dashboard/app/

Length of output: 353

🧰 Tools
🪛 Biome

[error] 75-82: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

Comment on lines +75 to 82
<div
onMouseDownCapture={() => {
const next = isSelected
? selected.filter((v) => v !== option.value)
: Array.from(new Set([...selected, option.value]));

setSelected(next);
// params.set(param, next);
}}
>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add key prop to the wrapper div.

The wrapper div in the iteration is missing a key prop, which is required for React's reconciliation process.

Apply this change:

  <div
+   key={option.value}
    onMouseDownCapture={() => {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<div
onMouseDownCapture={() => {
const next = isSelected
? selected.filter((v) => v !== option.value)
: Array.from(new Set([...selected, option.value]));
setSelected(next);
// params.set(param, next);
}}
>
<div
key={option.value}
onMouseDownCapture={() => {
const next = isSelected
? selected.filter((v) => v !== option.value)
: Array.from(new Set([...selected, option.value]));
setSelected(next);
}}
>
🧰 Tools
🪛 Biome

[error] 75-82: Missing key property for this element in iterable.

The order of the items may change, and having a key can help React identify which item was moved.
Check the React documentation.

(lint/correctness/useJsxKeyInIterable)

@BadriVishalPadhy
Copy link
Contributor Author

@chronark any issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auditlogs Filters can't press on filter
2 participants